home *** CD-ROM | disk | FTP | other *** search
/ Aminet 4 / Aminet 4 - November 1994.iso / aminet / comm / ums / ums109_1.lha / Tools / UMSMM.LHA / UMSMM / UMSMM.doc < prev    next >
Text File  |  1994-06-08  |  9KB  |  212 lines
  1.  
  2.  
  3.  
  4.           UMSMM 1.1 -*- UMS Mail Monitor -*- ©1994 Thomas Schwarz
  5.           =======================================================
  6.  
  7.                     based on Sabot V1.7 by Scott Ellis
  8.                     ==================================
  9.  
  10.  
  11.  
  12.                                 Documentation
  13.                                 =============
  14.  
  15.  
  16.  
  17. Description:
  18. ------------
  19.  
  20. UMSMM is basically a clone of Sabot by Scott Ellis, adapted  for  use  with
  21. UMS.
  22.  
  23. What UMSMM does is check your UMS messagebase for mail for a given user and
  24. do  things  when  some unread mail is there or arrives. Checks for new mail
  25. can be triggered either by watching a file or directory for  changes  using
  26. the AmigaDOS notification mechanism or by waiting specific amounts of time.
  27.  
  28. What UMSMM always does is display  an  AppIcon  on  your  Workbench  screen
  29. showing you the status of your private UMS "mailbox". If there is no unread
  30. mail for you it displays an icon illustrating an "empty mailbox". If  there
  31. are one or more unread mail messages waiting or something arrives, then the
  32. icon changes to a "full mailbox" icon  with  the  number  of  new  messages
  33. displayed, until you read your mail.
  34.  
  35. UMSMM can launch programs under three different circumstances:
  36.  
  37. o Mail arrives
  38.  
  39. o Mouse-Click on the AppIcon
  40.  
  41. o Files dropped onto the AppIcon
  42.  
  43.  
  44.  
  45. Call Syntax:
  46. ------------
  47.  
  48. KMSMM is started from  either  the  command  line  or  from  an  Icon  with
  49. appropriate ToolTypes. All options are optional unless otherwise stated:
  50.  
  51. UMSMM NAME/A,PASSWORD/A,SERVER/K,MA=MAIL/K,NM=NOMAIL/K,NO=NOTIFY/K,
  52.       TI=TIMER/K/N,XPOS/K/N,YPOS/K/N,CC=CLICKCOMMAND/K,CS=CLICKSTACK/K/N,
  53.       MC=MAILCOMMAND/K,MS=MAILSTACK/K/N,DC=DROPCOMMAND/K,DS=DROPSTACK/K/N
  54.  
  55.  
  56.  
  57. Functionality:
  58. --------------
  59.  
  60. Now let's have a deeper look at the available options:
  61.  
  62. NAME/A            The name of the UMS user who's mailbox is to be checked.
  63. PASSWORD/A        The corresponding UMS account password.
  64. SERVER/K          Logical name of the UMS server to be addressed.
  65. MA=MAIL/K         Name of icon to be shown to indicate the presence of
  66.                   unread mail (without ".info" extension). Def: "Filled"
  67. NM=NOMAIL/K       Name of icon to be shown to indicate that there is *no*
  68.                   new mail (without ".info" extension). Def: "Empty"
  69. NO=NOTIFY/K       Name of the file or directory to be monitored. Everytime
  70.                   this changes, a new check for mail is done. Def: No checks
  71. TI=TIMER/K/N      Number of seconds between mail checks. Def: No checks
  72. XPOS/K/N          Horizontal icon position in pixels. If left out, the icon
  73.                   will be free floating in the X direction.
  74. YPOS/K/N          Vertical icon position in pixels. If left out, the icon
  75.                   will be free floating in the Y direction, too.
  76. CC=CLICKCOMMAND/K Command to be executed when AppIcon is double-clicked
  77.                   (e.g. running your mail-/newsreader).
  78.                   Special command: "QUIT" quits UMSMM.
  79. CS=CLICKSTACK/K/N Stacksize which CLICKCOMMAND is to be run with. If
  80.                   CLICKCOMMAND was omitted, CLICKSTACK has no effect.
  81. MC=MAILCOMMAND/K  Command to be executed when new mail arrives
  82.                   (e.g. playing a sound sample).
  83. MS=MAILSTACK/K/N  Works according to CLICKSTACK, but for MAILCOMMAND.
  84. DC=DROPCOMMAND/K  Command to be executed when icons are dropped on the
  85.                   AppIcon. This command is executed once for each icon
  86.                   dropped with the name of the icon appended to it
  87.                   (e.g. a command to send the dropped files as mail).
  88.                   Commands that UMSMM executes are run asynchronously,
  89.                   so if you drag 100 icons onto UMSMM's AppIcon, it will 
  90.                   start 100 new processes. That can make for a really slow
  91.                   system ;-)
  92. DS=DROPSTACK/K/N  Works according to CLICKSTACK, but for DROPCOMMAND.
  93.  
  94.  
  95.  
  96. History:
  97. --------
  98.  
  99. V1.0 + Initial release
  100. V1.1 + Lost some memory when started from workbench
  101.      + If the number of new mails changed, the new number was not displayed
  102.      + Several cleanups
  103.      + Two new icons (mt*.info) contributed by Ralf Garbade. Thanks Ralf!
  104.  
  105.  
  106.  
  107. To do:
  108. ------
  109.  
  110. Find a better way for triggering mail checks. Perhaps in a  future  version
  111. of  UMS  there  will  be  some  mechanism  to  send some signal to external
  112. programs when special conditions like the arrival of mail are met?
  113.  
  114.  
  115.  
  116. Distribution:
  117. -------------
  118.  
  119. "UMSMailMon" is distributed under the terms  of  the  "GNU  GENERAL  PUBLIC
  120. LICENSE" which is included in the UMSMM archive.
  121.  
  122. It would be nice, if I would be informed of any  modifications  or  further
  123. developments of UMSMM to coordinate and include them in new releases.
  124.  
  125.  
  126.  
  127. Author information:
  128. -------------------
  129.  
  130. It's me :-)
  131.  
  132. Thomas Schwarz
  133. Gieshügeler Straße 26
  134. 97218 Gerbrunn
  135. Germany
  136.  
  137. Email: blacky@bmagic.mayn.sub.de
  138.        blacky@bmagic.incubus.sub.org
  139.        Thomas_Schwarz@wue.maus.de
  140.  
  141.  
  142.  
  143. Acknowledgements:
  144. -----------------
  145.  
  146. This program is heavily based on source code taken from the "Sabot" package
  147. written by Scott Ellis.
  148.  
  149.  
  150.  
  151. Disclaimer:
  152. -----------
  153.  
  154. This product is meant for educational purposes  only.  Any  resemblance  to
  155. real persons, living or dead is purely coincidental. Void where prohibited.
  156. Some  assembly  required.  List  each  check  separately  by  bank  number.
  157. Batteries  not  included.  Contents may settle during shipment. Use only as
  158. directed. No  other  warranty  expressed  or  implied.  Do  not  use  while
  159. operating  a  motor  vehicle  or  heavy  equipment. Postage will be paid by
  160. addressee.  Subject  to  CAB  approval.  This  is  not  an  offer  to  sell
  161. securities.  Apply  only  to  affected  area.  May  be too intense for some
  162. viewers. Do  not  stamp.  Use  other  side  for  additional  listings.  For
  163. recreational  use only. Do not disturb. All models over 18 years of age. If
  164. condition persists,  consult  your  physician.  No  user-serviceable  parts
  165. inside.  Freshest if eaten before date on carton. Subject to change without
  166. notice. Times approximate.  Simulated  picture.  No  postage  necessary  if
  167. mailed  in  the  United  States.  Breaking  seal  constitutes acceptance of
  168. agreement. For off-road use only. As seen on TV. One size  fits  all.  Many
  169. suitcases   look  alike.  Contains  a  substantial  amount  of  non-tobacco
  170. ingredients. Colors may, in time, fade. We have sent the forms  which  seem
  171. to be right for you. Slippery when wet. For office use only. Not affiliated
  172. with the American Red Cross. Drop in any mailbox.  Edited  for  television.
  173. Keep  cool; process promptly. Post office will not deliver without postage.
  174. List was current at time of printing. Return to sender, no forwarding order
  175. on   file,  unable  to  forward.  Not  responsible  for  direct,  indirect,
  176. incidental or consequential damages resulting from  any  defect,  error  or
  177. failure  to  perform.  At  participating  locations  only. Not the Beatles.
  178. Penalty for private use. See label for sequence.  Substantial  penalty  for
  179. early  withdrawal.  Do not write below this line. Falling rock. Lost ticket
  180. pays maximum rate. Your cancelled check is your receipt. Add  toner.  Place
  181. stamp here. Avoid contact with skin. Sanitized for your protection. Be sure
  182. each item is properly endorsed. Sign here without admitting guilt. Slightly
  183. higher  west  of  the  Mississippi.  Employees  and  their families are not
  184. eligible. Beware of dog. Contestants have been briefed  on  some  questions
  185. before  the  show.  Limited time offer, call now to insure prompt delivery.
  186. You must be present to win. No passes  accepted  for  this  engagement.  No
  187. purchase necessary. Processed at location stamped in code at top of carton.
  188. Shading within a garment may occur. Use only in well-ventilated area.  Keep
  189. away  from  fire  or  flame. Replace with same type. Approved for veterans.
  190. Booths for two or more. Check here if tax deductible. Some equipment  shown
  191. is  optional.  Price  does  not  include  taxes.  No  Canadian  coins.  Not
  192. recommended for children. Prerecorded  for  this  time  zone.  Reproduction
  193. strictly  prohibited.  No  solicitors.  No  alcohol,  dogs,  or  horses. No
  194. anchovies unless otherwise specified. Restaurant package, not  for  resale.
  195. List at least two alternate dates. First pull up, then pull down. Call toll
  196. free before digging. Driver does not carry cash.  Some  of  the  trademarks
  197. mentioned  in  this product appear for identification purposes only. Record
  198. additional transactions on back of previous stub.  Decision  of  judges  is
  199. final.
  200.  
  201. This supersedes all previous notices.
  202.  
  203.  
  204.  
  205. Quote of the day:
  206. -----------------
  207.  
  208. The trouble with having an open mind, of course, is that people will insist
  209.               on coming along and trying to put things in it.
  210.                        -- (Terry Pratchett, Diggers)
  211.  
  212.